/**
 * @file es8311_audio_codec.h
 * @brief ES8311音频编解码器头文件
 * @author zzh
 * @date 2024-04-20
 */

#ifndef _ES8311_AUDIO_CODEC_H
#define _ES8311_AUDIO_CODEC_H

#include "audio_codec.h"

#include <driver/i2c_master.h>
#include <driver/gpio.h>
#include <esp_codec_dev.h>
#include <esp_codec_dev_defaults.h>

/**
 * @brief ES8311音频编解码器类
 * 
 * 实现了基于ES8311的音频编解码器，支持双工通信，
 * 可配置输入和输出采样率，支持功率放大器控制。
 */
class Es8311AudioCodec : public AudioCodec {
private:
    /** @brief I2S数据接口 */
    const audio_codec_data_if_t* data_if_ = nullptr;
    /** @brief 控制接口 */
    const audio_codec_ctrl_if_t* ctrl_if_ = nullptr;
    /** @brief 编解码器接口 */
    const audio_codec_if_t* codec_if_ = nullptr;
    /** @brief GPIO接口 */
    const audio_codec_gpio_if_t* gpio_if_ = nullptr;

    /** @brief 输出设备句柄 */
    esp_codec_dev_handle_t output_dev_ = nullptr;
    /** @brief 输入设备句柄 */
    esp_codec_dev_handle_t input_dev_ = nullptr;
    /** @brief 功率放大器引脚 */
    gpio_num_t pa_pin_ = GPIO_NUM_NC;

    /**
     * @brief 创建双工通道
     * @param mclk 主时钟引脚
     * @param bclk 位时钟引脚
     * @param ws 字选择引脚
     * @param dout 数据输出引脚
     * @param din 数据输入引脚
     */
    void CreateDuplexChannels(gpio_num_t mclk, gpio_num_t bclk, gpio_num_t ws, gpio_num_t dout, gpio_num_t din);

    /**
     * @brief 从设备读取音频数据
     * @param dest 目标缓冲区
     * @param samples 要读取的样本数
     * @return 实际读取的样本数
     */
    virtual int Read(int16_t* dest, int samples) override;
    
    /**
     * @brief 向设备写入音频数据
     * @param data 源数据缓冲区
     * @param samples 要写入的样本数
     * @return 实际写入的样本数
     */
    virtual int Write(const int16_t* data, int samples) override;

public:
    /**
     * @brief 构造函数
     * @param i2c_master_handle I2C主设备句柄
     * @param i2c_port I2C端口
     * @param input_sample_rate 输入采样率
     * @param output_sample_rate 输出采样率
     * @param mclk 主时钟引脚
     * @param bclk 位时钟引脚
     * @param ws 字选择引脚
     * @param dout 数据输出引脚
     * @param din 数据输入引脚
     * @param pa_pin 功率放大器引脚
     * @param es8311_addr ES8311设备地址
     * @param use_mclk 是否使用主时钟
     */
    Es8311AudioCodec(void* i2c_master_handle, i2c_port_t i2c_port, int input_sample_rate, int output_sample_rate,
        gpio_num_t mclk, gpio_num_t bclk, gpio_num_t ws, gpio_num_t dout, gpio_num_t din,
        gpio_num_t pa_pin, uint8_t es8311_addr, bool use_mclk = true);
    
    /**
     * @brief 析构函数
     */
    virtual ~Es8311AudioCodec();

    /**
     * @brief 设置输出音量
     * @param volume 音量值
     */
    virtual void SetOutputVolume(int volume) override;
    
    /**
     * @brief 启用或禁用音频输入
     * @param enable 是否启用输入
     */
    virtual void EnableInput(bool enable) override;
    
    /**
     * @brief 启用或禁用音频输出
     * @param enable 是否启用输出
     */
    virtual void EnableOutput(bool enable) override;
};

#endif // _ES8311_AUDIO_CODEC_H